<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>web2py.gluon.rewrite</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="web2py.gluon-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://www.web2py.com">web2py Web Framework</a></th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        Package&nbsp;web2py ::
        <a href="web2py.gluon-module.html">Package&nbsp;gluon</a> ::
        Module&nbsp;rewrite
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="web2py.gluon.rewrite-module.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== MODULE DESCRIPTION ==================== -->
<h1 class="epydoc">Module rewrite</h1><span class="codelink"><a href="web2py.gluon.rewrite-pysrc.html">source&nbsp;code</a></span><br /><br />
This file is part of web2py Web Framework (Copyrighted, 2007-2010). 
  Developed by Massimo Di Pierro &lt;mdipierro@cs.depaul.edu&gt;. License: 
  GPL v2<br /><br />

<!-- ==================== FUNCTIONS ==================== -->
<a name="section-Functions"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Functions</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Functions"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="_params_default"></a><span class="summary-sig-name">_params_default</span>(<span class="summary-sig-arg">app</span>=<span class="summary-sig-default">1</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="web2py.gluon.rewrite-pysrc.html#_params_default">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="compile_re"></a><span class="summary-sig-name">compile_re</span>(<span class="summary-sig-arg">k</span>,
        <span class="summary-sig-arg">v</span>)</span><br />
      Preprocess and compile the regular expressions in routes_app/in/out

The resulting regex will match a pattern of the form:

    [remote address]:[protocol]://[host]:[method] [path]

We allow abbreviated regexes on input; here we try to complete them.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="web2py.gluon.rewrite-pysrc.html#compile_re">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="load"></a><span class="summary-sig-name">load</span>(<span class="summary-sig-arg">routes</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">routes.py</code><code class="variable-quote">'</code></span>,
        <span class="summary-sig-arg">app</span>=<span class="summary-sig-default">1</span>)</span><br />
      load: read and parse routes.py (called from main.py at web2py 
      initialization time) store results in params</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="web2py.gluon.rewrite-pysrc.html#load">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="filter_uri"></a><span class="summary-sig-name">filter_uri</span>(<span class="summary-sig-arg">e</span>,
        <span class="summary-sig-arg">regexes</span>,
        <span class="summary-sig-arg">tag</span>,
        <span class="summary-sig-arg">default</span>=<span class="summary-sig-default">1</span>)</span><br />
      filter incoming URI against a list of regexes</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="web2py.gluon.rewrite-pysrc.html#filter_uri">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="select"></a><span class="summary-sig-name">select</span>(<span class="summary-sig-arg">env</span>=<span class="summary-sig-default">1</span>,
        <span class="summary-sig-arg">app</span>=<span class="summary-sig-default">1</span>)</span><br />
      select a set of rewrite params for the current request called from
      main.wsgibase before any URL rewriting</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="web2py.gluon.rewrite-pysrc.html#select">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="filter_in"></a><span class="summary-sig-name">filter_in</span>(<span class="summary-sig-arg">e</span>)</span><br />
      called from main.wsgibase to rewrite incoming URL</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="web2py.gluon.rewrite-pysrc.html#filter_in">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="filter_out"></a><span class="summary-sig-name">filter_out</span>(<span class="summary-sig-arg">url</span>,
        <span class="summary-sig-arg">e</span>=<span class="summary-sig-default">1</span>)</span><br />
      called from html.URL to rewrite outgoing URL</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="web2py.gluon.rewrite-pysrc.html#filter_out">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="try_redirect_on_error"></a><span class="summary-sig-name">try_redirect_on_error</span>(<span class="summary-sig-arg">http_object</span>,
        <span class="summary-sig-arg">request</span>,
        <span class="summary-sig-arg">ticket</span>=<span class="summary-sig-default">1</span>)</span><br />
      called from main.wsgibase to rewrite the http response</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="web2py.gluon.rewrite-pysrc.html#try_redirect_on_error">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="filter_url"></a><span class="summary-sig-name">filter_url</span>(<span class="summary-sig-arg">url</span>,
        <span class="summary-sig-arg">method</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">get</code><code class="variable-quote">'</code></span>,
        <span class="summary-sig-arg">remote</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">0.0.0.0</code><code class="variable-quote">'</code></span>,
        <span class="summary-sig-arg">out</span>=<span class="summary-sig-default">False</span>,
        <span class="summary-sig-arg">app</span>=<span class="summary-sig-default">False</span>)</span><br />
      doctest interface to filter_in() and filter_out()</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="web2py.gluon.rewrite-pysrc.html#filter_url">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="filter_err"></a><span class="summary-sig-name">filter_err</span>(<span class="summary-sig-arg">status</span>,
        <span class="summary-sig-arg">application</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">app</code><code class="variable-quote">'</code></span>,
        <span class="summary-sig-arg">ticket</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">tkt</code><code class="variable-quote">'</code></span>)</span><br />
      doctest interface to routes_onerror</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="web2py.gluon.rewrite-pysrc.html#filter_err">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
</table>
<!-- ==================== VARIABLES ==================== -->
<a name="section-Variables"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Variables</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Variables"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="regex_at"></a><span class="summary-name">regex_at</span> = <code title="re.compile(r'(?&lt;!\\)\$[a-zA-Z]\w*')">re.compile(r'<code class="re-group">(?&lt;!</code>\\<code class="re-group">)</code>\$<code class="re-group">[</code>a<code class="re-op">-</code>zA<code class="re-op">-</code>Z<code class="re-group">]</code>\w<code class="re-op">*</code>')</code>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="regex_anything"></a><span class="summary-name">regex_anything</span> = <code title="re.compile(r'(?&lt;!\\)\$anything')">re.compile(r'<code class="re-group">(?&lt;!</code>\\<code class="re-group">)</code>\$anything')</code>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="web2py.gluon.rewrite-module.html#regex_iter" class="summary-name">regex_iter</a> = <code title="re.compile(r'.*code=(?P&lt;code&gt;\d+)&amp;ticket=(?P&lt;ticket&gt;.+).*')">re.compile(r'.<code class="re-op">*</code>code=<code class="re-group">(?P&lt;</code><code class="re-ref">code</code><code class="re-group">&gt;</code>\d<code class="re-op">+</code><code class="re-group">)</code>&amp;ticket=<code class="re-group">(?P&lt;</code><code class="re-ref">tick</code><code class="variable-ellipsis">...</code></code>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="logger"></a><span class="summary-name">logger</span> = <code title="logging.getLogger('web2py.rewrite')">logging.getLogger('web2py.rewrite')</code>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="thread"></a><span class="summary-name">thread</span> = <code title="threading.local()">threading.local()</code>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="params_apps"></a><span class="summary-name">params_apps</span> = <code title="{}"><code class="variable-group">{</code><code class="variable-group">}</code></code>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="web2py.gluon.rewrite-module.html#params" class="summary-name">params</a> = <code title="&lt;Storage {'routes_out': [], 'name': 'BASE', 'routes_apps_raw': [], 'er\
ror_message': '&lt;html&gt;&lt;body&gt;&lt;h1&gt;%s&lt;/h1&gt;&lt;/body&gt;&lt;/html&gt;', 'default_functi\
on': 'index', 'default_controller': 'default', 'error_handler': None, \
'routes_app': [], 'routes_in': [], 'default_application': 'init', 'err\
or_message_ticket': '&lt;html&gt;&lt;body&gt;&lt;h1&gt;Internal error&lt;/h1&gt;Ticket issued:\
 &lt;a href=&quot;/admin/default/ticket/%(ticket)s&quot; target=&quot;_blank&quot;&gt;%(ticket)s\
&lt;/a&gt;&lt;/body&gt;&lt;!-- this is junk text else IE does not display the page: x\
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\
...">&lt;Storage {'routes_out': [], 'name': 'BASE', 'routes_a<code class="variable-ellipsis">...</code></code>
    </td>
  </tr>
</table>
<!-- ==================== VARIABLES DETAILS ==================== -->
<a name="section-VariablesDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Variables Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-VariablesDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="regex_iter"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">regex_iter</h3>
  
  <dl class="fields">
  </dl>
  <dl class="fields">
    <dt>Value:</dt>
      <dd><table><tr><td><pre class="variable">
re.compile(r'.<code class="re-op">*</code>code=<code class="re-group">(?P&lt;</code><code class="re-ref">code</code><code class="re-group">&gt;</code>\d<code class="re-op">+</code><code class="re-group">)</code>&amp;ticket=<code class="re-group">(?P&lt;</code><code class="re-ref">ticket</code><code class="re-group">&gt;</code>.<code class="re-op">+</code><code class="re-group">)</code>.<code class="re-op">*</code>')
</pre></td></tr></table>
</dd>
  </dl>
</td></tr></table>
</div>
<a name="params"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">params</h3>
  
  <dl class="fields">
  </dl>
  <dl class="fields">
    <dt>Value:</dt>
      <dd><table><tr><td><pre class="variable">
&lt;Storage {'routes_out': [], 'name': 'BASE', 'routes_apps_raw': [], 'er<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
ror_message': '&lt;html&gt;&lt;body&gt;&lt;h1&gt;%s&lt;/h1&gt;&lt;/body&gt;&lt;/html&gt;', 'default_functi<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
on': 'index', 'default_controller': 'default', 'error_handler': None, <span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
'routes_app': [], 'routes_in': [], 'default_application': 'init', 'err<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
or_message_ticket': '&lt;html&gt;&lt;body&gt;&lt;h1&gt;Internal error&lt;/h1&gt;Ticket issued:<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
 &lt;a href=&quot;/admin/default/ticket/%(ticket)s&quot; target=&quot;_blank&quot;&gt;%(ticket)s<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
&lt;/a&gt;&lt;/body&gt;&lt;!-- this is junk text else IE does not display the page: x<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
<code class="variable-ellipsis">...</code>
</pre></td></tr></table>
</dd>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="web2py.gluon-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://www.web2py.com">web2py Web Framework</a></th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0beta1 on Wed Oct 13 19:44:38 2010
    </td>
    <td align="right" class="footer">
      <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie()
  // -->
</script>
  
</body>
</html>
